4.4.6.1 关联组织架构-基于id
可通过此接口在用户目录为角色关联组织架构。
基本信息
请求地址:
https://SDPC-IP:4433/api/v3/role/assignGroupById
请求方式:
POST
请求头(Header)
- 请求体(Body)
参数 | 中文名称 | 必须 | 类型 | 描述 |
---|---|---|---|---|
directoryDomain | 用户目录唯一标识 | 是 | string | 用户目录唯一标识,在控制台点击用户目录设置即可查看。 本地用户目录的唯一标识为 local 。外部用户目录示例: custom01339 (唯一标识无需携带@) |
id | 角色 id | 是 | string | 示例:d05aa128-e1de-11ee-835b-fefcfeefe529 |
group | 组织架构 | 是 | object | |
├─ op | 操作方式 | 否 | string | 操作类型。 取值范围: append -追加更新(默认)reset -重置delete -删除。 |
├─ key | 组织架构唯一标识 | 是 | string | key 是指标识组织架构的对象,即通过什么方式(或值)来关联指定的组织架构。零信任提供了三种标识来定义组织架构,即 id/fullPath/externalId。 取值范围: id -组织架构idfullPath -组织架构全路径externalId -组织架构外部id |
├─ data | 组织架构唯一标识对应数据 | 是 | string / string[] | data 是 key 值的结果,即若 key 的赋值是 fullPath,那么 data 对应的赋值就是组织架构全路径,如: /客服体系/专家中心/零信任专家组。若 key 的赋值是 externalId ,那么 data 就需要写组织架构的外部id值。 key 与 data 的对应取值示例如下: id :1345c177-e4f6-11ee-835b-fefcfeefe529fullPath :/客服体系/专家中心/零信任专家组externalId :202cb962ac59075b964b07152d234b70 |
- 请求示例
curl --location --request POST 'https://SDPC-IP:4433/api/v3/role/assignGroupById?lang=zh-CN' \
--header 'Content-Type: application/json' \
--header 'X-Ca-Key: {{X-Ca-Key}}' \
--header 'X-Ca-Nonce: {{X-Ca-Nonce}}' \
--header 'X-Ca-TimeStamp: {{X-Ca-TimeStamp}}' \
--header 'X-Ca-Sign: {{X-Ca-Sign}}' \
--data-raw '{
"directoryDomain": "custom01339",
"id": "d05aa128-e1de-11ee-835b-fefcfeefe529",
"group": {
"op": "append",
"key": "fullPath",
"data": [
"/客服体系/专家中心/零信任专家组",
"/客服体系/专家中心/零信任售后组"
]
}
}'
- 返回数据
参数 | 中文名称 | 类型 | 描述 |
---|---|---|---|
code | 响应码 | string | OK 表示成功,其他表示出错。具体含义请参考错误码定义 |
data | 响应数据 | object | |
msg | 描述信息 | string | |
traceId | 调用链id | string |
- 响应示例
{
"code": "OK",
"data": {},
"msg": "请求成功",
"traceId": "005a098301894abb"
}
错误码